Classname: ug_feature_share
This is the system-level ug_feature_share class.
DefClass: ug_feature_share ( );
The testInterference method will return true if the body on which this feature
exists has interference with the input body or body-based feature.
Input: (Any) Input Entity - Any of (class) ug_body instance, or
UG body hostpointer, or (class) ug_feature
instance, or UG body feature hostpointer.
If a feature is specified, the feature will be
converted to the body of the feature.
Error is generated if the input is not valid.
Return: (Boolean) - TRUE if the input entity has interference,
otherwise, FALSE.
(Method Boolean) testInterference:(Any $input_entity)
@{
ug_feature_testInterference(self:, $input_entity);
};
This testContainPoint method will return true if the body on which this feature
exists contains the given point.
Input: (Point) - A point that needs to be checked.
Return: (Boolean) - TRUE if this feature contains the given point,
otherwise, FALSE.
(Method Boolean) testContainPoint:(Point $input_point)
@{
ug_feature_testContainPoint(self:, $input_point);
};
The faceClosestToPoint method will return the face of a body-based feature
which is closest to the given point.
Input: (Point) - A point that needs to be checked.
Return: (Any) - The face which is closed to the given point.
If the face has been adopted by UG Knowledge Fusion,
it returns the name of a ug_face instance.
If the face has not been adopted, it returns
host pointer.
(Method Any) faceClosestToPoint:(Point $input_point)
@{
ug_feature_askFaceClosestToPoint(self:, $input_point);
};
The faceIntersectedByRay method will return the face(s) of a body-based
feature that is pierced by the given ray.
Input: (Point) point - A starting point of ray.
(Vector) vector - direction of ray.
Return: (List) - A list of face(s).
If the face has been adopted by UG Knowledge Fusion,
it returns the name of a ug_face instance in the list.
If the face has not been adopted, it returns
host pointer in the list.
If there are no faces found, an empty list is
returned.
(Method List) faceIntersectedByRay:(Point $starting_point, Vector $direction_vector)
@{
ug_feature_askFaceIntersectedByRay(self:, $starting_point, $direction_vector);
};
The edgeClosestToPoint method will return the edge of a body-based feature
which is the closest to the given point.
Input: (Point) - The input point.
Return: (Any) - The edge.
If the edge has been adopted by UG Knowledge Fusion,
it returns the name of a ug_edge instance.
If the edge has not been adopted, it returns
host pointer.
(Method Any) edgeClosestToPoint:(Point $input_point)
@{
ug_feature_askEdgeClosestToPoint(self:, $input_point);
};
The edgeClosestToRay method will return the edges of a body-based feature
that is closest to the given ray.
Input: (Point) point - A starting point of ray.
(Number) radius - radius of ray
(Vector) vector - direction of ray.
Return: (Any) - The edge.
If the edge has been adopted by UG Knowledge Fusion,
it returns the name of a ug_edge instance.
If the edge has not been adopted, it returns
host pointer.
(Method Any) edgeClosestToRay:(Point $starting_point, Number $radius, Vector $direction_vector)
@{
ug_feature_askEdgeClosestToRay(self:, $starting_point, $radius, $direction_vector);
};
This parameter controls if the feature appears in the
model navigator(MNT) and in the edit feature dialog.
It is recommended that this attribute only be used at creation
time. If edited after creation, the Part Navigator may not
immediately refresh to reflect the change.
(Parameter Boolean) inMntTree?: TRUE;
This attribute controls the failure behavior of the feature.
If a feature fails to update the system will evaluate this attribute.
The attribute return the following result:
1) None - Continue as usual (Default).
2) Continue - Continue with the update and mark the feature as out of date.
3) Suppress - Suppress the feature.
4) Delete - Delete the feature.
5) Undo - Undo the changes.
(List)EDUcontrol_init: {None,Continue,Suppress,Delete,Undo};
(Name Parameter) EDUcontrol: None;